Inside Macintosh: QuickDraw GX Printing Extensions and Drivers /

Chapter 4 - Printing Messages / Printing Messages Reference

Printing Messages / Spooling Messages

GXCompleteSpoolFile

QuickDraw GX sends the GXCompleteSpoolFile message when spooling of a document has been completed and the spool file is about to be closed. You can override the GXCompleteSpoolFile message to conclude operations on a spool file. Your override of the GXCompleteSpoolFile message must match the following formal declaration:

OSErr MyCompleteSpoolFile (gxSpoolFile aSpoolFile);

aSpoolFile

The spool file.

function result

An error code. The value noErr indicates that the operation was successful.

DESCRIPTION

QuickDraw GX, in its default implementation of the GXFinishJob message, sends the GXCompleteSpoolFile message when spooling is complete and the spool file is about to be closed.

You can override this message to determine when a spool file is closing or to conclude your operations on the spool file. You can also override this message if you have code you wish to execute once per spooled job.

The default implementation of the GXCompleteSpoolFile message finishes the spooling process and closes the file.

SPECIAL CONSIDERATIONS

You rarely send the GXCompleteSpoolFile message yourself.

If you are providing your own spooling, you need to totally override the GXCompleteSpoolFile message and all of the other spooling and despooling messages.

If you are not providing your own spooling, you must forward the GXCompleteSpoolFile message to allow the default implementation to finish spooling data and close the spool file.

RESULT CODES

gxSegmentLoadFailedErr	A required code segment could not be found, or there was not enough memory to load it.
gxPrUserAbortErr	The user has canceled printing.

SEE ALSO

The GXFinishJob message is described on page 4-54.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help